<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>query_script_report: common_schema documentation</title>
	<meta name="description" content="query_script_report: common_schema" />
	<meta name="keywords" content="query_script_report: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="query_script_report.html">query_script_report</a></h2>	

<p>
<strong>report</strong>: generate formatted report at end of script execution 
</p>

<h3>SYNOPSIS</h3>
<p>
<blockquote><pre>report h1 'My title';
report 'concatenated ', 'text, numbers, ', @user_variables, ' and ', $local_variables;
report p 'Starting paragraph, ', @name, ' review'; 
report li $x, ' is validated, bullet';
report code 'SET $x := 5';
report hr;
</pre></blockquote>
</p>

<h3>DESCRIPTION</h3>
<p> 
	<i>report</i> builds a fancy report throughout execution of the script. The report itself
	is only presented as the script terminates gracefully (without error). Thus,
	invocation of <i>report</i> statements aggregate report messages in the background, and
	do not immediately prompt or otherwise affect execution and output of script. 
</p>
<p>
	<i>report</i> concatenates its arguments into a single string. Anything that is
	valid within a <a href="http://dev.mysql.com/doc/refman/5.1/en/string-functions.html#function_concat">CONCAT()</a>
	function is accepted by <i>report</i>. This includes user defined variables, local variables
	and expanded variables.
</p>
<p>
	Line breaks (<strong>\n</strong>) will make for distinct rows in the resulting report.
</p>
<p>
	<i>report</i> accepts formatting hints, in an HTML-like format. These are:
	<ul>
		<li><strong>h1</strong>: title (prettified by underline)</li>
		<li><strong>p</strong>: begin paragraph</li>
		<li><strong>li</strong>: bullet (prefix with "- ")</li>
		<li><strong>code</strong>: source code (prefixed with "> ")</li>
		<li><strong>hr</strong>: horizontal line</li>
	</ul>
	The formatting hint is optional, and only one hint per <i>report</i> statement is accepted.
</p>

<h3>EXAMPLES</h3>

<p>A built-in report in <i>common_schema</i> is <a href="security_audit.html">security_audit</a>.</p>

<p>
Analyze and report some <i>common_schema</i> objects:
<blockquote><pre>
report h1 'common_schema overview';

report p 'common_schema offers:';

var $num_public_prodecures, $num_public_functions;

select 
  SUM(routine_type = 'PROCEDURE'), SUM(routine_type = 'FUNCTION') 
FROM 
  information_schema.ROUTINES 
WHERE 
  routine_schema='common_schema' AND routine_name NOT LIKE '\_%'
INTO 
  $num_public_prodecures, $num_public_functions;

report li $num_public_prodecures, ' public procedures';
report li $num_public_functions, ' public functions';


var $num_public_tables, $num_public_views;
select 
  SUM(table_type='base table'), SUM(table_type='view') 
FROM 
  information_schema.TABLES
WHERE 
  table_schema='common_schema' AND table_name NOT LIKE '\_%'
INTO 
  $num_public_tables, $num_public_views;

report li $num_public_tables, ' public tables';
report li $num_public_views, ' public views';

report li (select count(*) from help_content), ' help pages';


+------------------------------------------+
| report                                   |
+------------------------------------------+
|                                          |
| common_schema overview                   |
| ======================                   |
|                                          |
| common_schema offers:                    |
| - 19 public procedures                   |
| - 32 public functions                    |
| - 3 public tables                        |
| - 34 public views                        |
| - 131 help pages                         |
| ---                                      |
| Report generated on '2012-09-29 13:42:11 |
+------------------------------------------+
</pre></blockquote>
</p>


<h3>SEE ALSO</h3>
<a href="query_script_echo.html">echo</a>,
<a href="query_script_statements.html">Statements</a>

<h3>AUTHOR</h3>
Shlomi Noach


				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
